<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>
  Class: Vertx::FileSystem
  
    &mdash; Ruby API Doc
  
</title>

  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />

  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
  hasFrames = window.top.frames.main ? true : false;
  relpath = '../';
  framesUrl = "../frames.html#!" + escape(window.location.href);
</script>


  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>

  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>


  </head>
  <body>
    <div id="header">
      <div id="menu">
  
    <a href="../_index.html">Index (F)</a> &raquo;
    <span class='title'><span class='object_link'><a href="../Vertx.html" title="Vertx (module)">Vertx</a></span></span>
     &raquo; 
    <span class="title">FileSystem</span>
  

  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
</div>

      <div id="search">
  
    <a class="full_list_link" id="class_list_link"
        href="../class_list.html">
      Class List
    </a>
  
    <a class="full_list_link" id="method_list_link"
        href="../method_list.html">
      Method List
    </a>
  
    <a class="full_list_link" id="file_list_link"
        href="../file_list.html">
      File List
    </a>
  
</div>
      <div class="clear"></div>
    </div>

    <iframe id="search_frame"></iframe>

    <div id="content"><h1>Class: Vertx::FileSystem
  
  
  
</h1>

<dl class="box">
  
    <dt class="r1">Inherits:</dt>
    <dd class="r1">
      <span class="inheritName">Object</span>
      
        <ul class="fullTree">
          <li>Object</li>
          
            <li class="next">Vertx::FileSystem</li>
          
        </ul>
        <a href="#" class="inheritanceTree">show all</a>
      
      </dd>
    
  
  
    
  
    
  
  
  
    <dt class="r2 last">Defined in:</dt>
    <dd class="r2 last">src/main/api_shim/core/file_system.rb</dd>
  
</dl>
<div class="clear"></div>

<h2>Overview</h2><div class="docstring">
  <div class="discussion">
    Represents the file-system and contains a broad set of operations for manipulating files.
An asynchronous and a synchronous version of each operation is provided.
The asynchronous versions take a handler as a final argument which is
called when the operation completes or an error occurs. The handler is called
with two arguments; the first an exception, this will be nil if the operation has
succeeded. The second is the result - this will be nil if the operation failed or
there was no result to return.
The synchronous versions return the results, or throw exceptions directly.

  </div>
</div>
<div class="tags">
  
<p class="tag_title">Author:</p>
<ul class="author">
  
    <li>
      
      
      
      
        
        <div class='inline'><a href="http://tfox.org" target="_parent" title="Tim Fox">Tim Fox</a></div>
      
    </li>
  
</ul>

</div>
  <h2>Constant Summary</h2>
  
    <dl class="constants">
      
        <dt id="j_fs-classvariable" class="">@@j_fs =
          
        </dt>
        <dd><pre class="code"><span class='rubyid_org identifier id'>org</span><span class='dot token'>.</span><span class='rubyid_vertx identifier id'>vertx</span><span class='dot token'>.</span><span class='rubyid_java identifier id'>java</span><span class='dot token'>.</span><span class='rubyid_platform identifier id'>platform</span><span class='dot token'>.</span><span class='rubyid_impl identifier id'>impl</span><span class='dot token'>.</span><span class='rubyid_JRubyVerticleFactory constant id'>JRubyVerticleFactory</span><span class='dot token'>.</span><span class='rubyid_vertx identifier id'>vertx</span><span class='dot token'>.</span><span class='rubyid_fileSystem identifier id'>fileSystem</span><span class='lparen token'>(</span><span class='rparen token'>)</span>
</pre></dd>
      
    </dl>
  







  
    <h2>
      Class Method Summary
      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
    </h2>

    <ul class="summary">
      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#chmod-class_method" title="chmod (class method)">+ (Object) <strong>chmod</strong>(path, perms, dir_perms = nil, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Change the permissions on a file, asynchronously.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#chmod_sync-class_method" title="chmod_sync (class method)">+ (Object) <strong>chmod_sync</strong>(path, perms, dir_perms = nil) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.chmod.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#copy-class_method" title="copy (class method)">+ (Object) <strong>copy</strong>(from, to, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Copy a file, asynchronously.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#copy_recursive-class_method" title="copy_recursive (class method)">+ (Object) <strong>copy_recursive</strong>(from, to, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Copy a file recursively, asynchronously.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#copy_recursive_sync-class_method" title="copy_recursive_sync (class method)">+ (Object) <strong>copy_recursive_sync</strong>(from, to) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.copy_recursive.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#copy_sync-class_method" title="copy_sync (class method)">+ (Object) <strong>copy_sync</strong>(from, to) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.copy.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#create_file-class_method" title="create_file (class method)">+ (Object) <strong>create_file</strong>(path, perms = nil, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Create a new empty file, asynchronously.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#create_file_sync-class_method" title="create_file_sync (class method)">+ (Object) <strong>create_file_sync</strong>(path, perms = nil) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.create_file.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#delete-class_method" title="delete (class method)">+ (Object) <strong>delete</strong>(path, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Delete a file on the file system, asynchronously.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#delete_recursive-class_method" title="delete_recursive (class method)">+ (Object) <strong>delete_recursive</strong>(path, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Delete a file on the file system recursively, asynchronously.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#delete_recursive_sync-class_method" title="delete_recursive_sync (class method)">+ (Object) <strong>delete_recursive_sync</strong>(path) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.delete_recursive.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#delete_sync-class_method" title="delete_sync (class method)">+ (Object) <strong>delete_sync</strong>(path) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.delete.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#exists%3F-class_method" title="exists? (class method)">+ (Boolean) <strong>exists?</strong>(path, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Check if  a file exists, asynchronously.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#exists_sync%3F-class_method" title="exists_sync? (class method)">+ (Boolean) <strong>exists_sync?</strong>(path) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.exists?.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#fs_props-class_method" title="fs_props (class method)">+ (Object) <strong>fs_props</strong>(path, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Get properties for the file system, asynchronously.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#fs_props_sync-class_method" title="fs_props_sync (class method)">+ (Object) <strong>fs_props_sync</strong>(path) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.fs_props.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#link-class_method" title="link (class method)">+ (Object) <strong>link</strong>(link, existing, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Create a hard link, asynchronously..</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#link_sync-class_method" title="link_sync (class method)">+ (Object) <strong>link_sync</strong>(link, existing) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.link.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#mkdir-class_method" title="mkdir (class method)">+ (Object) <strong>mkdir</strong>(path, perms = nil, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Create a directory, asynchronously.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#mkdir_sync-class_method" title="mkdir_sync (class method)">+ (Object) <strong>mkdir_sync</strong>(path, perms = nil) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.mkdir.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#mkdir_with_parents-class_method" title="mkdir_with_parents (class method)">+ (Object) <strong>mkdir_with_parents</strong>(path, perms = nil, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Create a directory, and create all it's parent directories if they do not already exist, asynchronously.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#mkdir_with_parents_sync-class_method" title="mkdir_with_parents_sync (class method)">+ (Object) <strong>mkdir_with_parents_sync</strong>(path, perms = nil) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.mkdir_with_parents.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#move-class_method" title="move (class method)">+ (Object) <strong>move</strong>(from, to, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Move a file, asynchronously.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#move_sync-class_method" title="move_sync (class method)">+ (Object) <strong>move_sync</strong>(from, to) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.move.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#open-class_method" title="open (class method)">+ (Object) <strong>open</strong>(path, perms = nil, read = true, write = true, create_new = true, flush = false, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Open a file on the file system, asynchronously.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#open_sync-class_method" title="open_sync (class method)">+ (Object) <strong>open_sync</strong>(path, perms = nil, read = true, write = true, create_new = true, flush = false) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.open.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#props-class_method" title="props (class method)">+ (Object) <strong>props</strong>(path, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Get file properties for a file, asynchronously.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#props_sync-class_method" title="props_sync (class method)">+ (Object) <strong>props_sync</strong>(path) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.props.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#read_dir-class_method" title="read_dir (class method)">+ (Object) <strong>read_dir</strong>(path, filter = nil, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Read a directory, i.e.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#read_dir_sync-class_method" title="read_dir_sync (class method)">+ (Object) <strong>read_dir_sync</strong>(path, filter = nil) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.read_dir.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#read_file_as_buffer-class_method" title="read_file_as_buffer (class method)">+ (Object) <strong>read_file_as_buffer</strong>(path, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Read the contents of an entire file as a <span class='object_link'><a href="Buffer.html" title="Vertx::Buffer (class)">Buffer</a></span>, asynchronously.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#read_file_as_buffer_sync-class_method" title="read_file_as_buffer_sync (class method)">+ (Object) <strong>read_file_as_buffer_sync</strong>(path) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.read_file_as_buffer.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#read_symlink-class_method" title="read_symlink (class method)">+ (Object) <strong>read_symlink</strong>(link, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Read a symbolic link, asynchronously.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#read_symlink_sync-class_method" title="read_symlink_sync (class method)">+ (Object) <strong>read_symlink_sync</strong>(link) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.read_symlink.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#symlink-class_method" title="symlink (class method)">+ (Object) <strong>symlink</strong>(link, existing, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Create a symbolic link, asynchronously.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#symlink_sync-class_method" title="symlink_sync (class method)">+ (Object) <strong>symlink_sync</strong>(link, existing) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.symlink.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#truncate-class_method" title="truncate (class method)">+ (Object) <strong>truncate</strong>(path, len, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Truncate a file, asynchronously.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#truncate_sync-class_method" title="truncate_sync (class method)">+ (Object) <strong>truncate_sync</strong>(path, len) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.truncate.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#unlink-class_method" title="unlink (class method)">+ (Object) <strong>unlink</strong>(link, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Unlink a hard link.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#unlinkSync-class_method" title="unlinkSync (class method)">+ (Object) <strong>unlinkSync</strong>(link) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.unlink.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#write_buffer_to_file-class_method" title="write_buffer_to_file (class method)">+ (Object) <strong>write_buffer_to_file</strong>(path, buffer, &amp;block) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Write a [Buffer] as the entire contents of a file, asynchronously.</div></span>
  
</li>

      
        <li class="public ">
  <span class="summary_signature">
    
      <a href="#write_buffer_to_file_sync-class_method" title="write_buffer_to_file_sync (class method)">+ (Object) <strong>write_buffer_to_file_sync</strong>(path, buffer) </a>
    

    
  </span>
  
  
  
  
  
  
  

  
    <span class="summary_desc"><div class='inline'>Synchronous version of #FileSystem#FileSystem.write_buffer_to_file.</div></span>
  
</li>

      
    </ul>
  



  <div id="class_method_details" class="method_details_list">
    <h2>Class Method Details</h2>

    
      <div class="method_details first">
  <h3 class="signature first" id="chmod-class_method">
  
    + (<tt>Object</tt>) <strong>chmod</strong>(path, perms, dir_perms = nil, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Change the permissions on a file, asynchronously. If the file is directory then all contents will also have their permissions changed recursively.
<a href="http://download.oracle.com/javase/7/docs/api/java/nio/file/attribute/PosixFilePermissions.html" target="_parent" title="http://download.oracle.com/javase/7/docs/api/java/nio/file/attribute/PosixFilePermissions.html">http://download.oracle.com/javase/7/docs/api/java/nio/file/attribute/PosixFilePermissions.html</a>. This is
used to set the permissions for any regular files (not directories).

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>path</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of file to change permissions</div>
      
    </li>
  
    <li>
      
        <span class='name'>perms</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>A permission string of the form rwxr-x--- as specified in</div>
      
    </li>
  
    <li>
      
        <span class='name'>dir_perms</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>nil</tt>)</em>
      
      
        &mdash;
        <div class='inline'>A permission string of the form rwxr-x---. Used to set permissions for regular files.</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


227
228
229
230</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 227</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_chmod identifier id'>chmod</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span><span class='comma token'>,</span> <span class='rubyid_dir_perms identifier id'>dir_perms</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_chmod identifier id'>chmod</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span><span class='comma token'>,</span> <span class='rubyid_dir_perms identifier id'>dir_perms</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="chmod_sync-class_method">
  
    + (<tt>Object</tt>) <strong>chmod_sync</strong>(path, perms, dir_perms = nil) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.chmod

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


233
234
235
236</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 233</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_chmod_sync identifier id'>chmod_sync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span><span class='comma token'>,</span> <span class='rubyid_dir_perms identifier id'>dir_perms</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_chmodSync identifier id'>chmodSync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span><span class='comma token'>,</span> <span class='rubyid_dir_perms identifier id'>dir_perms</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="copy-class_method">
  
    + (<tt>Object</tt>) <strong>copy</strong>(from, to, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Copy a file, asynchronously. The copy will fail if from does not exist, or if to already exists.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>from</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of file to copy</div>
      
    </li>
  
    <li>
      
        <span class='name'>to</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of file to copy to</div>
      
    </li>
  
    <li>
      
        <span class='name'>hndlr</span>
      
      
        <span class='type'>(<tt>Block</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>a block representing the handler which is called on completion.</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


166
167
168
169</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 166</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_copy identifier id'>copy</span><span class='lparen token'>(</span><span class='rubyid_from identifier id'>from</span><span class='comma token'>,</span> <span class='rubyid_to identifier id'>to</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_copy identifier id'>copy</span><span class='lparen token'>(</span><span class='rubyid_from identifier id'>from</span><span class='comma token'>,</span> <span class='rubyid_to identifier id'>to</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="copy_recursive-class_method">
  
    + (<tt>Object</tt>) <strong>copy_recursive</strong>(from, to, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Copy a file recursively, asynchronously. The copy will fail if from does not exist, or if to already exists and is not empty.
If the source is a directory all contents of the directory will be copied recursively, i.e. the entire directory
tree is copied.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>from</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of file to copy</div>
      
    </li>
  
    <li>
      
        <span class='name'>to</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of file to copy to</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


182
183
184
185</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 182</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_copy_recursive identifier id'>copy_recursive</span><span class='lparen token'>(</span><span class='rubyid_from identifier id'>from</span><span class='comma token'>,</span> <span class='rubyid_to identifier id'>to</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_copy identifier id'>copy</span><span class='lparen token'>(</span><span class='rubyid_from identifier id'>from</span><span class='comma token'>,</span> <span class='rubyid_to identifier id'>to</span><span class='comma token'>,</span> <span class='rubyid_true true kw'>true</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="copy_recursive_sync-class_method">
  
    + (<tt>Object</tt>) <strong>copy_recursive_sync</strong>(from, to) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.copy_recursive

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


188
189
190
191</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 188</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_copy_recursive_sync identifier id'>copy_recursive_sync</span><span class='lparen token'>(</span><span class='rubyid_from identifier id'>from</span><span class='comma token'>,</span> <span class='rubyid_to identifier id'>to</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_copySync identifier id'>copySync</span><span class='lparen token'>(</span><span class='rubyid_from identifier id'>from</span><span class='comma token'>,</span> <span class='rubyid_to identifier id'>to</span><span class='comma token'>,</span> <span class='rubyid_true true kw'>true</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="copy_sync-class_method">
  
    + (<tt>Object</tt>) <strong>copy_sync</strong>(from, to) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.copy

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


172
173
174
175</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 172</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_copy_sync identifier id'>copy_sync</span><span class='lparen token'>(</span><span class='rubyid_from identifier id'>from</span><span class='comma token'>,</span> <span class='rubyid_to identifier id'>to</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_copySync identifier id'>copySync</span><span class='lparen token'>(</span><span class='rubyid_from identifier id'>from</span><span class='comma token'>,</span> <span class='rubyid_to identifier id'>to</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="create_file-class_method">
  
    + (<tt>Object</tt>) <strong>create_file</strong>(path, perms = nil, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Create a new empty file, asynchronously.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>path</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of the file to create.</div>
      
    </li>
  
    <li>
      
        <span class='name'>perms</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>nil</tt>)</em>
      
      
        &mdash;
        <div class='inline'>The file will be created with these permissions.</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


426
427
428
429</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 426</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_create_file identifier id'>create_file</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_createFile identifier id'>createFile</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="create_file_sync-class_method">
  
    + (<tt>Object</tt>) <strong>create_file_sync</strong>(path, perms = nil) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.create_file

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


432
433
434
435</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 432</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_create_file_sync identifier id'>create_file_sync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_createFileSync identifier id'>createFileSync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="delete-class_method">
  
    + (<tt>Object</tt>) <strong>delete</strong>(path, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Delete a file on the file system, asynchronously.
The delete will fail if the file does not exist, or is a directory and is not empty.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>path</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of the file to delete.</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


307
308
309
310</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 307</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_delete identifier id'>delete</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_delete identifier id'>delete</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="delete_recursive-class_method">
  
    + (<tt>Object</tt>) <strong>delete_recursive</strong>(path, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Delete a file on the file system recursively, asynchronously.
The delete will fail if the file does not exist. If the file is a directory the entire directory contents
will be deleted recursively.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>path</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of the file to delete.</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


322
323
324
325</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 322</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_delete_recursive identifier id'>delete_recursive</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_delete identifier id'>delete</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_true true kw'>true</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="delete_recursive_sync-class_method">
  
    + (<tt>Object</tt>) <strong>delete_recursive_sync</strong>(path) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.delete_recursive

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


328
329
330
331</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 328</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_delete_recursive_sync identifier id'>delete_recursive_sync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_deleteSync identifier id'>deleteSync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_true true kw'>true</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="delete_sync-class_method">
  
    + (<tt>Object</tt>) <strong>delete_sync</strong>(path) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.delete

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


313
314
315
316</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 313</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_delete_sync identifier id'>delete_sync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_deleteSync identifier id'>deleteSync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="exists?-class_method">
  
    + (<tt>Boolean</tt>) <strong>exists?</strong>(path, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Check if  a file exists, asynchronously.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>path</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of the file to check.</div>
      
    </li>
  
</ul>

<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>Boolean</tt>)</span>
      
      
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


439
440
441
442</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 439</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_exists? fid id'>exists?</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_exists identifier id'>exists</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="exists_sync?-class_method">
  
    + (<tt>Boolean</tt>) <strong>exists_sync?</strong>(path) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.exists?

  </div>
</div>
<div class="tags">
  
<p class="tag_title">Returns:</p>
<ul class="return">
  
    <li>
      
      
        <span class='type'>(<tt>Boolean</tt>)</span>
      
      
      
    </li>
  
</ul>

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


445
446
447</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 445</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_exists_sync? fid id'>exists_sync?</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_existsSync identifier id'>existsSync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="fs_props-class_method">
  
    + (<tt>Object</tt>) <strong>fs_props</strong>(path, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Get properties for the file system, asynchronously.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>path</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path in the file system.</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


451
452
453
454</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 451</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_fs_props identifier id'>fs_props</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_fsProps identifier id'>fsProps</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rubyid_j_props identifier id'>j_props</span><span class='bitor op'>|</span> <span class='rubyid_FSProps constant id'>FSProps</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_j_props identifier id'>j_props</span><span class='rparen token'>)</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="fs_props_sync-class_method">
  
    + (<tt>Object</tt>) <strong>fs_props_sync</strong>(path) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.fs_props

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


457
458
459
460</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 457</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_fs_props_sync identifier id'>fs_props_sync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='rparen token'>)</span>
  <span class='rubyid_j_fsprops identifier id'>j_fsprops</span> <span class='assign token'>=</span> <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_fsPropsSync identifier id'>fsPropsSync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='rparen token'>)</span>
  <span class='rubyid_FSProps constant id'>FSProps</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_j_fsprops identifier id'>j_fsprops</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="link-class_method">
  
    + (<tt>Object</tt>) <strong>link</strong>(link, existing, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Create a hard link, asynchronously..

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>link</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of the link to create.</div>
      
    </li>
  
    <li>
      
        <span class='name'>existing</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of where the link points to.</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


254
255
256
257</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 254</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_link identifier id'>link</span><span class='lparen token'>(</span><span class='rubyid_link identifier id'>link</span><span class='comma token'>,</span> <span class='rubyid_existing identifier id'>existing</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
   <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_link identifier id'>link</span><span class='lparen token'>(</span><span class='rubyid_link identifier id'>link</span><span class='comma token'>,</span> <span class='rubyid_existing identifier id'>existing</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
   <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="link_sync-class_method">
  
    + (<tt>Object</tt>) <strong>link_sync</strong>(link, existing) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.link

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


260
261
262
263</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 260</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_link_sync identifier id'>link_sync</span><span class='lparen token'>(</span><span class='rubyid_link identifier id'>link</span><span class='comma token'>,</span> <span class='rubyid_existing identifier id'>existing</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_linkSync identifier id'>linkSync</span><span class='lparen token'>(</span><span class='rubyid_link identifier id'>link</span><span class='comma token'>,</span> <span class='rubyid_existing identifier id'>existing</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="mkdir-class_method">
  
    + (<tt>Object</tt>) <strong>mkdir</strong>(path, perms = nil, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Create a directory, asynchronously.
The create will fail if the directory already exists, or if it contains parent directories which do not already
exist.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>path</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of the directory to create.</div>
      
    </li>
  
    <li>
      
        <span class='name'>perms.</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>A permission string of the form rwxr-x--- to give directory.</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


338
339
340
341</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 338</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_mkdir identifier id'>mkdir</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_mkdir identifier id'>mkdir</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="mkdir_sync-class_method">
  
    + (<tt>Object</tt>) <strong>mkdir_sync</strong>(path, perms = nil) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.mkdir

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


344
345
346
347</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 344</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_mkdir_sync identifier id'>mkdir_sync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_mkdirSync identifier id'>mkdirSync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="mkdir_with_parents-class_method">
  
    + (<tt>Object</tt>) <strong>mkdir_with_parents</strong>(path, perms = nil, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Create a directory, and create all it's parent directories if they do not already exist, asynchronously.
The create will fail if the directory already exists.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>path</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of the directory to create.</div>
      
    </li>
  
    <li>
      
        <span class='name'>perms.</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>A permission string of the form rwxr-x--- to give the created directory(ies).</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


353
354
355
356</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 353</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_mkdir_with_parents identifier id'>mkdir_with_parents</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_mkdir identifier id'>mkdir</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span><span class='comma token'>,</span> <span class='rubyid_true true kw'>true</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="mkdir_with_parents_sync-class_method">
  
    + (<tt>Object</tt>) <strong>mkdir_with_parents_sync</strong>(path, perms = nil) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.mkdir_with_parents

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


359
360
361
362</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 359</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_mkdir_with_parents_sync identifier id'>mkdir_with_parents_sync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_mkdirSync identifier id'>mkdirSync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span><span class='comma token'>,</span> <span class='rubyid_true true kw'>true</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="move-class_method">
  
    + (<tt>Object</tt>) <strong>move</strong>(from, to, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Move a file, asynchronously. The move will fail if from does not exist, or if to already exists.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>from</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of file to move</div>
      
    </li>
  
    <li>
      
        <span class='name'>to</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of file to move to</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


196
197
198
199</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 196</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_move identifier id'>move</span><span class='lparen token'>(</span><span class='rubyid_from identifier id'>from</span><span class='comma token'>,</span> <span class='rubyid_to identifier id'>to</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_move identifier id'>move</span><span class='lparen token'>(</span><span class='rubyid_from identifier id'>from</span><span class='comma token'>,</span> <span class='rubyid_to identifier id'>to</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="move_sync-class_method">
  
    + (<tt>Object</tt>) <strong>move_sync</strong>(from, to) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.move

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


202
203
204
205</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 202</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_move_sync identifier id'>move_sync</span><span class='lparen token'>(</span><span class='rubyid_from identifier id'>from</span><span class='comma token'>,</span> <span class='rubyid_to identifier id'>to</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_moveSync identifier id'>moveSync</span><span class='lparen token'>(</span><span class='rubyid_from identifier id'>from</span><span class='comma token'>,</span> <span class='rubyid_to identifier id'>to</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="open-class_method">
  
    + (<tt>Object</tt>) <strong>open</strong>(path, perms = nil, read = true, write = true, create_new = true, flush = false, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Open a file on the file system, asynchronously.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>path</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of the file to open.</div>
      
    </li>
  
    <li>
      
        <span class='name'>perms</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>nil</tt>)</em>
      
      
        &mdash;
        <div class='inline'>If the file does not exist and create_new is true, then the file will be created with these permissions.</div>
      
    </li>
  
    <li>
      
        <span class='name'>read</span>
      
      
        <span class='type'>(<tt>Boolean</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>true</tt>)</em>
      
      
        &mdash;
        <div class='inline'>Open the file for reading?</div>
      
    </li>
  
    <li>
      
        <span class='name'>write</span>
      
      
        <span class='type'>(<tt>Boolean</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>true</tt>)</em>
      
      
        &mdash;
        <div class='inline'>Open the file for writing?</div>
      
    </li>
  
    <li>
      
        <span class='name'>create_new</span>
      
      
        <span class='type'>(<tt>Boolean</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>true</tt>)</em>
      
      
        &mdash;
        <div class='inline'>Create the file if it doesn't already exist?</div>
      
    </li>
  
    <li>
      
        <span class='name'>flush</span>
      
      
        <span class='type'>(<tt>Boolean</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>false</tt>)</em>
      
      
        &mdash;
        <div class='inline'>Whenever any data is written to the file, flush all changes to permanent storage immediately?</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


412
413
414
415</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 412</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_open identifier id'>open</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='rubyid_read identifier id'>read</span> <span class='assign token'>=</span> <span class='rubyid_true true kw'>true</span><span class='comma token'>,</span> <span class='rubyid_write identifier id'>write</span> <span class='assign token'>=</span> <span class='rubyid_true true kw'>true</span><span class='comma token'>,</span> <span class='rubyid_create_new identifier id'>create_new</span> <span class='assign token'>=</span> <span class='rubyid_true true kw'>true</span><span class='comma token'>,</span> <span class='rubyid_flush identifier id'>flush</span> <span class='assign token'>=</span> <span class='rubyid_false false kw'>false</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_open identifier id'>open</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span><span class='comma token'>,</span> <span class='rubyid_read identifier id'>read</span><span class='comma token'>,</span> <span class='rubyid_write identifier id'>write</span><span class='comma token'>,</span> <span class='rubyid_create_new identifier id'>create_new</span><span class='comma token'>,</span> <span class='rubyid_flush identifier id'>flush</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span><span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rubyid_j_file identifier id'>j_file</span><span class='bitor op'>|</span> <span class='rubyid_AsyncFile constant id'>AsyncFile</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_j_file identifier id'>j_file</span><span class='rparen token'>)</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="open_sync-class_method">
  
    + (<tt>Object</tt>) <strong>open_sync</strong>(path, perms = nil, read = true, write = true, create_new = true, flush = false) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.open

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


418
419
420
421</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 418</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_open_sync identifier id'>open_sync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='rubyid_read identifier id'>read</span> <span class='assign token'>=</span> <span class='rubyid_true true kw'>true</span><span class='comma token'>,</span> <span class='rubyid_write identifier id'>write</span> <span class='assign token'>=</span> <span class='rubyid_true true kw'>true</span><span class='comma token'>,</span> <span class='rubyid_create_new identifier id'>create_new</span> <span class='assign token'>=</span> <span class='rubyid_true true kw'>true</span><span class='comma token'>,</span> <span class='rubyid_flush identifier id'>flush</span> <span class='assign token'>=</span> <span class='rubyid_false false kw'>false</span><span class='rparen token'>)</span>
  <span class='rubyid_j_af identifier id'>j_af</span> <span class='assign token'>=</span> <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_open identifier id'>open</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_perms identifier id'>perms</span><span class='comma token'>,</span> <span class='rubyid_read identifier id'>read</span><span class='comma token'>,</span> <span class='rubyid_write identifier id'>write</span><span class='comma token'>,</span> <span class='rubyid_create_new identifier id'>create_new</span><span class='comma token'>,</span> <span class='rubyid_flush identifier id'>flush</span><span class='rparen token'>)</span>
  <span class='rubyid_AsyncFile constant id'>AsyncFile</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_j_af identifier id'>j_af</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="props-class_method">
  
    + (<tt>Object</tt>) <strong>props</strong>(path, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Get file properties for a file, asynchronously.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>path</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path to file</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


240
241
242
243</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 240</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_props identifier id'>props</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_props identifier id'>props</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rubyid_j_props identifier id'>j_props</span><span class='bitor op'>|</span> <span class='rubyid_FileProps constant id'>FileProps</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_j_props identifier id'>j_props</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="props_sync-class_method">
  
    + (<tt>Object</tt>) <strong>props_sync</strong>(path) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.props

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


246
247
248
249</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 246</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_props_sync identifier id'>props_sync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='rparen token'>)</span>
  <span class='rubyid_j_props identifier id'>j_props</span> <span class='assign token'>=</span> <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_propsSync identifier id'>propsSync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='rparen token'>)</span>
  <span class='rubyid_FileProps constant id'>FileProps</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_j_props identifier id'>j_props</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="read_dir-class_method">
  
    + (<tt>Object</tt>) <strong>read_dir</strong>(path, filter = nil, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Read a directory, i.e. list it's contents, asynchronously.
The read will fail if the directory does not exist.
then only files which match the filter will be returned.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>path</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of the directory to read.</div>
      
    </li>
  
    <li>
      
        <span class='name'>filter</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>nil</tt>)</em>
      
      
        &mdash;
        <div class='inline'>A regular expression to filter out the contents of the directory. If the filter is not nil</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


369
370
371
372</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 369</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_read_dir identifier id'>read_dir</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_filter identifier id'>filter</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_readDir identifier id'>readDir</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_filter identifier id'>filter</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="read_dir_sync-class_method">
  
    + (<tt>Object</tt>) <strong>read_dir_sync</strong>(path, filter = nil) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.read_dir

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


375
376
377</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 375</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_read_dir_sync identifier id'>read_dir_sync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_filter identifier id'>filter</span> <span class='assign token'>=</span> <span class='rubyid_nil nil kw'>nil</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_readDirSync identifier id'>readDirSync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_filter identifier id'>filter</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="read_file_as_buffer-class_method">
  
    + (<tt>Object</tt>) <strong>read_file_as_buffer</strong>(path, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Read the contents of an entire file as a <span class='object_link'><a href="Buffer.html" title="Vertx::Buffer (class)">Buffer</a></span>, asynchronously.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>path</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of the file to read.</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


381
382
383
384</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 381</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_read_file_as_buffer identifier id'>read_file_as_buffer</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_readFile identifier id'>readFile</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rubyid_j_buff identifier id'>j_buff</span><span class='bitor op'>|</span> <span class='rubyid_Buffer constant id'>Buffer</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_j_buff identifier id'>j_buff</span><span class='rparen token'>)</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="read_file_as_buffer_sync-class_method">
  
    + (<tt>Object</tt>) <strong>read_file_as_buffer_sync</strong>(path) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.read_file_as_buffer

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


387
388
389</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 387</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_read_file_as_buffer_sync identifier id'>read_file_as_buffer_sync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_readFileSync identifier id'>readFileSync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="read_symlink-class_method">
  
    + (<tt>Object</tt>) <strong>read_symlink</strong>(link, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Read a symbolic link, asynchronously. I.e. tells you where the symbolic link points.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>link</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of the link to read.</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


294
295
296
297</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 294</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_read_symlink identifier id'>read_symlink</span><span class='lparen token'>(</span><span class='rubyid_link identifier id'>link</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_readSymlink identifier id'>readSymlink</span><span class='lparen token'>(</span><span class='rubyid_link identifier id'>link</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="read_symlink_sync-class_method">
  
    + (<tt>Object</tt>) <strong>read_symlink_sync</strong>(link) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.read_symlink

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


300
301
302</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 300</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_read_symlink_sync identifier id'>read_symlink_sync</span><span class='lparen token'>(</span><span class='rubyid_link identifier id'>link</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_readSymlinkSync identifier id'>readSymlinkSync</span><span class='lparen token'>(</span><span class='rubyid_link identifier id'>link</span><span class='rparen token'>)</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="symlink-class_method">
  
    + (<tt>Object</tt>) <strong>symlink</strong>(link, existing, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Create a symbolic link, asynchronously.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>link</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of the link to create.</div>
      
    </li>
  
    <li>
      
        <span class='name'>existing</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of where the link points to.</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


268
269
270
271</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 268</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_symlink identifier id'>symlink</span><span class='lparen token'>(</span><span class='rubyid_link identifier id'>link</span><span class='comma token'>,</span> <span class='rubyid_existing identifier id'>existing</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
   <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_symlink identifier id'>symlink</span><span class='lparen token'>(</span><span class='rubyid_link identifier id'>link</span><span class='comma token'>,</span> <span class='rubyid_existing identifier id'>existing</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
   <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="symlink_sync-class_method">
  
    + (<tt>Object</tt>) <strong>symlink_sync</strong>(link, existing) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.symlink

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


274
275
276
277</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 274</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_symlink_sync identifier id'>symlink_sync</span><span class='lparen token'>(</span><span class='rubyid_link identifier id'>link</span><span class='comma token'>,</span> <span class='rubyid_existing identifier id'>existing</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_symlinkSync identifier id'>symlinkSync</span><span class='lparen token'>(</span><span class='rubyid_link identifier id'>link</span><span class='comma token'>,</span> <span class='rubyid_existing identifier id'>existing</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="truncate-class_method">
  
    + (<tt>Object</tt>) <strong>truncate</strong>(path, len, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Truncate a file, asynchronously. The move will fail if path does not exist.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>path</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of file to truncate</div>
      
    </li>
  
    <li>
      
        <span class='name'>len</span>
      
      
        <span class='type'>(<tt>FixNum</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Length to truncate file to. Will fail if len &lt; 0. If len &gt; file size then will do nothing.</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


210
211
212
213</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 210</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_truncate identifier id'>truncate</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_len identifier id'>len</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_truncate identifier id'>truncate</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_len identifier id'>len</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="truncate_sync-class_method">
  
    + (<tt>Object</tt>) <strong>truncate_sync</strong>(path, len) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.truncate

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


216
217
218
219</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 216</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_truncate_sync identifier id'>truncate_sync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_len identifier id'>len</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_truncateSync identifier id'>truncateSync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_len identifier id'>len</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="unlink-class_method">
  
    + (<tt>Object</tt>) <strong>unlink</strong>(link, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Unlink a hard link.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>link</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of the link to unlink.</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


281
282
283
284</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 281</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_unlink identifier id'>unlink</span><span class='lparen token'>(</span><span class='rubyid_link identifier id'>link</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_unlink identifier id'>unlink</span><span class='lparen token'>(</span><span class='rubyid_link identifier id'>link</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="unlinkSync-class_method">
  
    + (<tt>Object</tt>) <strong>unlinkSync</strong>(link) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.unlink

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


287
288
289
290</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 287</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_unlinkSync identifier id'>unlinkSync</span><span class='lparen token'>(</span><span class='rubyid_link identifier id'>link</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_unlinkSync identifier id'>unlinkSync</span><span class='lparen token'>(</span><span class='rubyid_link identifier id'>link</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="write_buffer_to_file-class_method">
  
    + (<tt>Object</tt>) <strong>write_buffer_to_file</strong>(path, buffer, &amp;block) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Write a [Buffer] as the entire contents of a file, asynchronously.

  </div>
</div>
<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>path</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>Path of the file to write.</div>
      
    </li>
  
    <li>
      
        <span class='name'>buffer</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
      
        &mdash;
        <div class='inline'>The Buffer to write</div>
      
    </li>
  
</ul>


</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


394
395
396
397</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 394</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_write_buffer_to_file identifier id'>write_buffer_to_file</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_buffer identifier id'>buffer</span><span class='comma token'>,</span> <span class='bitand op'>&amp;</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_writeFile identifier id'>writeFile</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_buffer identifier id'>buffer</span><span class='comma token'>,</span> <span class='rubyid_ARWrappedHandler constant id'>ARWrappedHandler</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_block identifier id'>block</span><span class='rparen token'>)</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
      <div class="method_details ">
  <h3 class="signature " id="write_buffer_to_file_sync-class_method">
  
    + (<tt>Object</tt>) <strong>write_buffer_to_file_sync</strong>(path, buffer) 
  

  

  
</h3><div class="docstring">
  <div class="discussion">
    Synchronous version of Vertx::FileSystem#FileSystem#FileSystem.write_buffer_to_file

  </div>
</div>
<div class="tags">
  

</div><table class="source_code">
  <tr>
    <td>
      <pre class="lines">


400
401
402
403</pre>
    </td>
    <td>
      <pre class="code"><span class="info file"># File 'src/main/api_shim/core/file_system.rb', line 400</span>

<span class='rubyid_def def kw'>def</span> <span class='rubyid_FileSystem constant id'>FileSystem</span><span class='dot token'>.</span><span class='rubyid_write_buffer_to_file_sync identifier id'>write_buffer_to_file_sync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_buffer identifier id'>buffer</span><span class='rparen token'>)</span>
  <span class='rubyid_@@j_fs ivar id'>@@j_fs</span><span class='dot token'>.</span><span class='rubyid_writeFileSync identifier id'>writeFileSync</span><span class='lparen token'>(</span><span class='rubyid_path identifier id'>path</span><span class='comma token'>,</span> <span class='rubyid_buffer identifier id'>buffer</span><span class='rparen token'>)</span>
  <span class='rubyid_self self kw'>self</span>
<span class='rubyid_end end kw'>end</span>
</pre>
    </td>
  </tr>
</table>
</div>
    
  </div>

</div>

    <div id="footer">
  Generated on Wed Jul 17 20:30:38 2013 by
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
  0.8.6.1 (ruby-1.9.3).
</div>

  </body>
</html>